Skip to content

feat(web): add docsUrl for providers to install from#1061

Open
KaviiSuri wants to merge 2 commits intopingdotgg:mainfrom
KaviiSuri:kavii/add-install-docs-for-providers
Open

feat(web): add docsUrl for providers to install from#1061
KaviiSuri wants to merge 2 commits intopingdotgg:mainfrom
KaviiSuri:kavii/add-install-docs-for-providers

Conversation

@KaviiSuri
Copy link

@KaviiSuri KaviiSuri commented Mar 14, 2026 •
edited by macroscopeapp bot
Loading

Closes #627

What Changed

The health check banner now includes a link to docs, so users know where to download from.

Why

Currently, the installation instructions are not included in error message. can cause confusion.

UI Changes

Before:
image

After:
image

Checklist

  • This PR is small and focused
  • I explained what changed and why
  • I included before/after screenshots for any UI changes
  • I included a video for animation/interaction changes

Note

Add docsUrl to provider options and render an installation guide link in ProviderHealthBanner

  • Adds a docsUrl field to each entry in PROVIDER_OPTIONS in session-logic.ts for codex, claudeCode, and cursor.
  • Updates ProviderHealthBanner.tsx to render an 'Installation Guide' anchor when the current provider has a docsUrl.
  • Adds ensureSentenceEnds to utils.ts to normalize banner message punctuation.

Macroscope summarized fcaaead.

@coderabbitai
Copy link

coderabbitai bot commented Mar 14, 2026 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 801ec115-2466-4426-a9ef-f89e71835ac4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

You can customize the tone of the review comments and chat replies.

Configure the tone_instructions setting to customize the tone of the review comments and chat replies. For example, you can set the tone to Act like a strict teacher, Act like a pirate and more.

@github-actions github-actions bot added size:M 30-99 changed lines (additions + deletions). vouch:unvouched PR author is not yet trusted in the VOUCHED list. labels Mar 14, 2026
@KaviiSuri KaviiSuri force-pushed the kavii/add-install-docs-for-providers branch from 36829ae to 0770674 Compare March 14, 2026 09:05
Bashamega
Bashamega reviewed Mar 14, 2026
View reviewed changes
apps/web/src/session-logic.ts Outdated
value: ProviderPickerKind;
label: string;
available: boolean;
docsUrl: string | null;
Copy link
Contributor

@Bashamega Bashamega Mar 14, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is always docs, so why make it nullable?

Copy link
Author

@KaviiSuri KaviiSuri Mar 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i added just to not make a requirement, changing this.

Copy link
Author

@KaviiSuri KaviiSuri Mar 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@KaviiSuri KaviiSuri requested a review from Bashamega March 15, 2026 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@Bashamega Bashamega Bashamega approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

size:M 30-99 changed lines (additions + deletions). vouch:unvouched PR author is not yet trusted in the VOUCHED list.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Point to codex install docs when codex not found

2 participants

@KaviiSuri @Bashamega